<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>NGUI: Next-Gen UI kit: TypewriterEffect Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">NGUI: Next-Gen UI kit
   &#160;<span id="projectnumber">3.7.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_typewriter_effect.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_typewriter_effect-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">TypewriterEffect Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This script is able to fill in the label's text gradually, giving the effect of someone typing or fading in the content over time.  
 <a href="class_typewriter_effect.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for TypewriterEffect:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_typewriter_effect.png" usemap="#TypewriterEffect_map" alt=""/>
  <map id="TypewriterEffect_map" name="TypewriterEffect_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad9bc784ff58bc550663a6d24e42059b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#ad9bc784ff58bc550663a6d24e42059b0">ResetToBeginning</a> ()</td></tr>
<tr class="memdesc:ad9bc784ff58bc550663a6d24e42059b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the typewriter effect to the beginning of the label.  <a href="#ad9bc784ff58bc550663a6d24e42059b0">More...</a><br /></td></tr>
<tr class="separator:ad9bc784ff58bc550663a6d24e42059b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adefe0afe379626ce176de1237c5469df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#adefe0afe379626ce176de1237c5469df">Finish</a> ()</td></tr>
<tr class="memdesc:adefe0afe379626ce176de1237c5469df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish the typewriter operation and show all the text right away.  <a href="#adefe0afe379626ce176de1237c5469df">More...</a><br /></td></tr>
<tr class="separator:adefe0afe379626ce176de1237c5469df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a74f32059e960e0085a56b78f8d81c4a2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#a74f32059e960e0085a56b78f8d81c4a2">charsPerSecond</a> = 20</td></tr>
<tr class="memdesc:a74f32059e960e0085a56b78f8d81c4a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">How many characters will be printed per second.  <a href="#a74f32059e960e0085a56b78f8d81c4a2">More...</a><br /></td></tr>
<tr class="separator:a74f32059e960e0085a56b78f8d81c4a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1a9cc49123bdef17ae5e19b03d47f5c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#ae1a9cc49123bdef17ae5e19b03d47f5c">fadeInTime</a> = 0f</td></tr>
<tr class="memdesc:ae1a9cc49123bdef17ae5e19b03d47f5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long it takes for each character to fade in.  <a href="#ae1a9cc49123bdef17ae5e19b03d47f5c">More...</a><br /></td></tr>
<tr class="separator:ae1a9cc49123bdef17ae5e19b03d47f5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c5371305bd19b4bfcefd757ea185d74"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#a5c5371305bd19b4bfcefd757ea185d74">delayOnPeriod</a> = 0f</td></tr>
<tr class="memdesc:a5c5371305bd19b4bfcefd757ea185d74"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long to pause when a period is encountered (in seconds).  <a href="#a5c5371305bd19b4bfcefd757ea185d74">More...</a><br /></td></tr>
<tr class="separator:a5c5371305bd19b4bfcefd757ea185d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d51e83839a48cac94f249a4054ac647"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#a9d51e83839a48cac94f249a4054ac647">delayOnNewLine</a> = 0f</td></tr>
<tr class="memdesc:a9d51e83839a48cac94f249a4054ac647"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long to pause when a new line character is encountered (in seconds).  <a href="#a9d51e83839a48cac94f249a4054ac647">More...</a><br /></td></tr>
<tr class="separator:a9d51e83839a48cac94f249a4054ac647"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bff08508bfcc79e4444f443e28c1067"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_i_scroll_view.html">UIScrollView</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#a7bff08508bfcc79e4444f443e28c1067">scrollView</a></td></tr>
<tr class="memdesc:a7bff08508bfcc79e4444f443e28c1067"><td class="mdescLeft">&#160;</td><td class="mdescRight">If a scroll view is specified, its UpdatePosition() function will be called every time the text is updated.  <a href="#a7bff08508bfcc79e4444f443e28c1067">More...</a><br /></td></tr>
<tr class="separator:a7bff08508bfcc79e4444f443e28c1067"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9562c58bde0f7dc1da39a479ad5e7815"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#a9562c58bde0f7dc1da39a479ad5e7815">keepFullDimensions</a> = false</td></tr>
<tr class="memdesc:a9562c58bde0f7dc1da39a479ad5e7815"><td class="mdescLeft">&#160;</td><td class="mdescRight">If set to 'true', the label's dimensions will be that of a fully faded-in content.  <a href="#a9562c58bde0f7dc1da39a479ad5e7815">More...</a><br /></td></tr>
<tr class="separator:a9562c58bde0f7dc1da39a479ad5e7815"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bc7826e5465da9a89ee1161bff1fd10"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="class_event_delegate.html">EventDelegate</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#a7bc7826e5465da9a89ee1161bff1fd10">onFinished</a> = new List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt;()</td></tr>
<tr class="memdesc:a7bc7826e5465da9a89ee1161bff1fd10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event delegate triggered when the typewriter effect finishes.  <a href="#a7bc7826e5465da9a89ee1161bff1fd10">More...</a><br /></td></tr>
<tr class="separator:a7bc7826e5465da9a89ee1161bff1fd10"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a02fc8a0ce1fef4ae0952405472f3def3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_typewriter_effect.html">TypewriterEffect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#a02fc8a0ce1fef4ae0952405472f3def3">current</a></td></tr>
<tr class="separator:a02fc8a0ce1fef4ae0952405472f3def3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:add0ca7bba2272a6463ae14c705a4ce40"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_typewriter_effect.html#add0ca7bba2272a6463ae14c705a4ce40">isActive</a><code> [get]</code></td></tr>
<tr class="memdesc:add0ca7bba2272a6463ae14c705a4ce40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the typewriter effect is currently active or not.  <a href="#add0ca7bba2272a6463ae14c705a4ce40">More...</a><br /></td></tr>
<tr class="separator:add0ca7bba2272a6463ae14c705a4ce40"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This script is able to fill in the label's text gradually, giving the effect of someone typing or fading in the content over time. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="adefe0afe379626ce176de1237c5469df"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void TypewriterEffect.Finish </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Finish the typewriter operation and show all the text right away. </p>

</div>
</div>
<a class="anchor" id="ad9bc784ff58bc550663a6d24e42059b0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void TypewriterEffect.ResetToBeginning </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset the typewriter effect to the beginning of the label. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a74f32059e960e0085a56b78f8d81c4a2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int TypewriterEffect.charsPerSecond = 20</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>How many characters will be printed per second. </p>

</div>
</div>
<a class="anchor" id="a02fc8a0ce1fef4ae0952405472f3def3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_typewriter_effect.html">TypewriterEffect</a> TypewriterEffect.current</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a9d51e83839a48cac94f249a4054ac647"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float TypewriterEffect.delayOnNewLine = 0f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>How long to pause when a new line character is encountered (in seconds). </p>

</div>
</div>
<a class="anchor" id="a5c5371305bd19b4bfcefd757ea185d74"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float TypewriterEffect.delayOnPeriod = 0f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>How long to pause when a period is encountered (in seconds). </p>

</div>
</div>
<a class="anchor" id="ae1a9cc49123bdef17ae5e19b03d47f5c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float TypewriterEffect.fadeInTime = 0f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>How long it takes for each character to fade in. </p>

</div>
</div>
<a class="anchor" id="a9562c58bde0f7dc1da39a479ad5e7815"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool TypewriterEffect.keepFullDimensions = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If set to 'true', the label's dimensions will be that of a fully faded-in content. </p>

</div>
</div>
<a class="anchor" id="a7bc7826e5465da9a89ee1161bff1fd10"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt; TypewriterEffect.onFinished = new List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt;()</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Event delegate triggered when the typewriter effect finishes. </p>

</div>
</div>
<a class="anchor" id="a7bff08508bfcc79e4444f443e28c1067"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_u_i_scroll_view.html">UIScrollView</a> TypewriterEffect.scrollView</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If a scroll view is specified, its UpdatePosition() function will be called every time the text is updated. </p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="add0ca7bba2272a6463ae14c705a4ce40"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool TypewriterEffect.isActive</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Whether the typewriter effect is currently active or not. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/Projects/NGUI/Assets/NGUI/Scripts/Interaction/<a class="el" href="_typewriter_effect_8cs.html">TypewriterEffect.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_typewriter_effect.html">TypewriterEffect</a></li>
    <li class="footer">Generated on Sat Sep 13 2014 05:29:17 for NGUI: Next-Gen UI kit by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
  </ul>
</div>
</body>
</html>
